summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index d048e0b..c6511f4 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,11 @@ SRS Anywhere is free software: you can redistribute it and/or modify it under th
SRS Anywhere is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with SRS Anywhere. If not, see <https://www.gnu.org/licenses/.>.
+## Building
+
+Just run `make`.
+The build process is very simple, it just tangles the CSS and JavaScript code into an HTML template using `sed`.
+
## Usage
Open `srs-anywhere.html` in a web browser and press the "Browse..." button in the top right-hand corner to load a deck of cards.