Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
The Tor Project
Network Health
sbws
Commits
c790824c
Commit
c790824c
authored
Apr 22, 2018
by
Matt Traudt
Browse files
Add info on layout of sbws repo
GH: closes #100
parent
26a6391b
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
c790824c
...
...
@@ -80,6 +80,21 @@ The sbws documentation can be found at
[
this onion service
](
http://d7pxflytfsmz6uh3x7i2jxzzwea6nbpmtsz5tmfkcin5edapaig5vpyd.onion/
)
(
[
v2
](
http://sdmb3rfvp3wadu6y.onion/
)
).
## Layout of the sbws repo
-
`docs/`
the source of the sbws documentation website.
-
`sbws/`
the source code for sbws.
-
`sbws/core/`
each file contains code specific to a single sbws command.
-
`sbws/lib/`
complex data structures and classes useful to one or more sbws
commands. If you're making a new class, it probably belongs here.
-
`sbws/util/`
simplier, "make life easier" collections of functions.
-
`scripts/maint/`
scripts for
**maint**
aining sbws and doing administrative
things like regenerating the website or updating the AUTHORS file.
-
`scripts/tools/`
misc. scripts for users of sbws.
-
`tests/testnets/`
scripts and code for running mini Tor networks locally and
performing integration tests with them.
-
`tests/`
unit tests executed with
`pytest`
or
`tox`
.
### Build HTML documentation
pip install -e .[doc]
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment