diff --git a/README.md b/README.md index 325f9c3..37d4e1e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# Builder +# Spitfire Builder +This is a simple bash script for building the Spitfire Browser based on Mozilla Firefox source code. + +## Dependencies + +- Mercurial (hg) +- Git + +## Usage + +Run the script `builder.sh` with the following options: + +- `-a, --all` : Perform all steps (build, clean, update). +- `-b, --build` : Build Spitfire. +- `-c, --clean` : Clean build. +- `-u, --update` : Update Mozilla repository. +- `-p, --patches` : Update patches. +- `-h, --help` : Display usage instructions. + +For example: + +```bash +./builder.sh --all \ No newline at end of file