move issues into ISSUES/ ; shorten readme

This commit is contained in:
pho4cexa 2023-02-01 16:24:28 -08:00
parent 12790c87e4
commit 64aa954d32
20 changed files with 27 additions and 63 deletions

3
ISSUES/0002.txt Normal file
View file

@ -0,0 +1,3 @@
A plain text file issue
with a short description

3
ISSUES/0003 Normal file
View file

@ -0,0 +1,3 @@
Another plain text file issue with no extension
and a short description

View file

View file

View file

@ -0,0 +1,2 @@
because I don't usebecause i don't use m455's vim-markdown-toc plugin and they get out-of-sync

View file

View file

View file

@ -0,0 +1 @@
like uniqueness checking, sequential numbering

View file

@ -0,0 +1,2 @@
display binary files as output from binary-file analysis tools
like `hexdump`, `xxd`, `dumpelf`, `elfls`, `readelf`, etc.?

View file

View file

@ -101,22 +101,22 @@ specified directory, where your `default.html` template lives.
The following variables are available to templates:
- source_files_list: a list of all the files in the repo.
- repository_description: a short description of the repo, if provided. See configuration.
- repository_name: the name of the repo. See configuration.
- repository_path: the URL path from the forge root to the repo.
- repository_path_parent: repository_path without the repo itself.
- repository_ancestors: a list of each path element in repository_path_parent
- readme_file: the filename of the README file, if any. used for the "about" link.
- license_file: the filename of the LICENSE file, if any. used for the "license" link.
- issues_file: if any files exist in ISSUES/, this will be set to "ISSUES".
- repo2html_version: the blob hash of main.scm in this repository.
- source_file: the filename of the file being rendered.
- root: always "" (TODO: omit this?)
- elements: a list of each path element leading to the file being rendered
- basename: the filename being rendered, with one extension removed
- extension: the extension removed in basename
- relative_root: "html/" if the current file is "/index.html" otherwise ""
- `source_files_list`: a list of all the files in the repo.
- `repository_description`: a short description of the repo, if provided. See configuration.
- `repository_name`: the name of the repo. See configuration.
- `repository_path`: the URL path from the forge root to the repo.
- `repository_path_parent`: repository_path without the repo itself.
- `repository_ancestors`: a list of each path element in repository_path_parent.
- `readme_file`: the filename of the README file, if any. used for the "about" link.
- `license_file`: the filename of the LICENSE file, if any. used for the "license" link.
- `issues_file`: if any files exist in ISSUES/, this will be set to "ISSUES".
- `repo2html_version`: the blob hash of main.scm in this repository.
- `source_file`: the filename of the file being rendered.
- `root`: always empty. # TODO FIXME
- `elements`: a list of each path element leading to the file being rendered.
- `basename`: the filename being rendered, with one extension removed.
- `extension`: the extension removed in basename.
- `relative_root`: `html/` if the current file is `/index.html` otherwise empty.
## Configuration
@ -197,50 +197,3 @@ Other tools like `repo2html`, that generate a set of HTML files representing the
- [stagit](https://codemadness.org/git/stagit/file/README.html)
- [depp](https://git.8pit.net/depp.git/)
- [git-arr](https://blitiri.com.ar/p/git-arr/)
### Git Forge Software
Software for self-hosting or building your own collection of many git repos for potentially multiple users.
- [GitLab](https://about.gitlab.com/install/)
- [Gogs](https://gogs.io/)
- [Gitea](https://gitea.io/)
- [cgit](https://git.zx2c4.com/cgit/)
- [GitWeb](https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb)
- [legit](https://git.icyphox.sh/legit)
- [gitile](https://git.lepiller.eu/gitile)
- [pagure](https://pagure.io/pagure)
### Git Forge Services
Third-party-hosted services that will host browsable code repositories.
- [NotABug](https://notabug.org/)
- [Codeberg](https://codeberg.org/)
- [sourcehut](https://sourcehut.org/)
- [GitLab](https://gitlab.com/)
- [SourceForge](https://sourceforge.net/)
- Red Hat [pagure](https://pagure.io/pagure)
- Atlassian Bitbucket
- Microsoft GitHub
## Todos
- **documentation**: move all of these TODOs into ISSUES/
- **documentation**: provide a precompiled binary download
- **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**: diffs for each commit
- **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**: syntax highlighting?
- **feature**: markdown-render git log text
- **feature**: other mechanisms for header id application like uniqueness
checking, sequential numbering
- **feature**: remotes, upstream identification, and tracking branch status
- **feature**: reimplement a table-of-contents mechanism because i don't use m455's vim-markdown-toc plugin and they get out-of-sync