diff --git a/README.md b/README.md index fc0bcc6..10aa489 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # repo2html -A command-line tool that generates a static HTML representation of a Git repository. +A command-line tool that generates a static HTML representation of a Git +repository. ## Page contents @@ -50,9 +51,11 @@ A command-line tool that generates a static HTML representation of a Git reposit repo2html -Run `repo2html` inside the root directory of a Git repository or a bare Git repository. +Run `repo2html` inside the root directory of a Git repository or a bare Git +repository. -- `` is the path to the directory that you want the HTML files to be generated in. +- `` is the path to the directory that you want the HTML files to + be generated in. - `` is the path to the directory that contains a `default.html` file. Refer to `assets/templates/default.html` for an example `default.html` file. @@ -69,7 +72,8 @@ into the `/usr/local/bin` directory. 1. Ensure you're in the `repo2html` git repository. 2. As root, run `make dependencies` to install the required Chicken Scheme eggs. 3. Run `make` to compile a static `repo2html` binary in the current directory. -4. As root, run `make install` to copy the `repo2html` binary into the `/usr/local/bin` directory. +4. As root, run `make install` to copy the `repo2html` binary into the + `/usr/local/bin` directory. **Note**: If you want to use `main.scm` as the `repo2html` executable, instead of compiling a static binary file, then run @@ -84,18 +88,25 @@ You can `repo2html` by changing the following items: ### Templates -You can customize `repo2html` by editing the `assets/templates/default.html`, and then specifying the path to the `default.html` file as the second command-line argument when running `repo2html`. +You can customize `repo2html` by editing the `assets/templates/default.html`, +and then specifying the path to the `default.html` file as the second +command-line argument when running `repo2html`. -For example, if you placed a `default.html` file in `~/bin`, and you serve HTML files from `/var/www/git`, then you run `repo2html /var/www/git ~/bin`. +For example, if you placed a `default.html` file in `~/bin`, and you serve HTML +files from `/var/www/git`, then you run `repo2html /var/www/git ~/bin`. ### Environment variables -You can provide a generic description by setting the `REPO2HTML_DESCRIPTION` environment variable, or by adding a description in a `description` file in the root directory of your Git repository. +You can provide a generic description by setting the `REPO2HTML_DESCRIPTION` +environment variable, or by adding a description in a `description` file in the +root directory of your Git repository. ## Setting up a Git forge on your web server -Refer to [Create a Git forge with repo2html](documentation/create-a-git-forge-with-repo2html.md.html) to learn how use -`repo2html` as a post-receive hook to auto-generate HTML webpages for bare Git repositories on a remote web server. +Refer to +[Create a Git forge with repo2html](html/documentation/create-a-git-forge-with-repo2html.md.html) +to learn how use `repo2html` as a post-receive hook to auto-generate HTML +webpages for bare Git repositories on a remote web server. ## Alternative Git-to-HTML tools @@ -124,14 +135,17 @@ Refer to [Create a Git forge with repo2html](documentation/create-a-git-forge-wi ## Todos -- **documentation/feature**: use post-update rather than post-receive hook for simplicity +- **documentation/feature**: use post-update rather than post-receive hook for + simplicity - **documentation**: also describe use with post-commit hook - **documentation**: describe readme, license, and issues behaviours - **feature**: multi-page or collapse-able files list - **feature**: branches and releases (tags) - **feature**: clickable line numbers in source files -- **feature**: display binary files as output from binary-file analysis tools like `hexdump`, `xxd`, `dumpelf`, `elfls`, `readelf`, etc.? +- **feature**: display binary files as output from binary-file analysis tools + like `hexdump`, `xxd`, `dumpelf`, `elfls`, `readelf`, etc.? - **feature**: syntax highlighting? - **feature**: markdown-render git log text -- **feature**: other mechanisms for header id application like uniqueness checking, sequential numbering +- **feature**: other mechanisms for header id application like uniqueness + checking, sequential numbering