Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beejjorgensen/bgnet0
Beej's Guide to Network Concepts source
https://github.com/beejjorgensen/bgnet0
Last synced: 2 months ago
JSON representation
Beej's Guide to Network Concepts source
- Host: GitHub
- URL: https://github.com/beejjorgensen/bgnet0
- Owner: beejjorgensen
- License: other
- Created: 2023-03-14T23:23:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T22:45:18.000Z (2 months ago)
- Last Synced: 2024-11-05T23:31:33.521Z (2 months ago)
- Language: HTML
- Size: 1020 KB
- Stars: 139
- Watchers: 4
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- my-awesome-github-stars - beejjorgensen/bgnet0 - Beej's Guide to Network Concepts source (HTML)
README
# Beej's Guide to Network Concepts
This is the source for Beej's Guide to Network Concepts. Not Beej's
Guide to Network Programming in C.
If you merely wish to read the guide, please visit the [Beej's Guide to
Network Concepts](https://beej.us/guide/bgnet0/) website.
This is here so that Beej has everything in a repo and so translators
can easily clone it.
## Build Instructions
### Dependencies
* [Gnu make](https://www.gnu.org/software/make/) (XCode make works, too)
* [Python 3+](https://www.python.org/)
* [Pandoc 2.7.3+](https://pandoc.org/)
* XeLaTeX (can be found in [TeX Live](https://www.tug.org/texlive/))
* [Liberation fonts](https://en.wikipedia.org/wiki/Liberation_fonts) (sans, serif, mono)
Mac dependencies install (reopen terminal after doing this):
```
xcode-select --install # installs make
brew install python # installs Python3
brew install pandoc
brew install mactex # installs XeLaTeX
brew tap homebrew/cask-fonts
brew install font-liberation # installs Liberation fonts
```
You might have to add something like this to your path to find `xelatex`:
```
PATH=$PATH:/usr/local/texlive/2021/bin/universal-darwin
```
### Dependency: Build System
This depends on an external repo to build: [Beej's Guide Build System
for Pandoc](https://github.com/beejjorgensen/bgbspd).
You'll want to clone that repo as a sibling to this one:
```
mystuff-->bggit
\-->bgbspd
```
The Makefiles here will look for the build system there.
You can override the `bgbspd` directory before running `make` like this:
```
export BGBSPD_BUILD_DIR=/some/path/to/bgbspd
```
### Build
1. Type `make all` from the top-level directory.
If you have Gnu Make, it should work fine. Other makes might work as
well. Windows users might want to check out Cygwin.
2. Type `make stage` to copy all the build products and website to the
`stage` directory.
3. There is no step three.
You can also `cd` to the `src` directory and `make`.
`make clean` cleans, and `make pristine` cleans to "original" state.
To embed your own fonts in the PDFs, see the `src/Makefile` for examples.
The `upload` target in the root `Makefile` demonstrates the build steps
for a complete release. You'll need to change the `UPLOADDIR` macro in
the top-level `Makefile` to point to your host if you want to use that.
You're free to upload whatever versions you desire individually, as
well.
## Pull Requests
Please keep these on the scale of typo and bug fixes. That way I don't
have to consider any copyright issues when merging changes.