Skip to content

Commit

Permalink
docs: update doc/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sdarwin authored Dec 11, 2023
1 parent 8249695 commit 02c6984
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 372 deletions.
34 changes: 5 additions & 29 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,19 @@
## Instructions for Documentation

There are different possible configurations when building the docs:
Scripts to build the documentation can be found at https://github.com/boostorg/release-tools/tree/master/build_docs

Option 1. Start out with single boost library, such as the one in this repository. A new boost-root directory is generated for you, next to the current repo, (in the location ../boost-root) and the docs are output to ../boost-root/libs/_name-of-this-repo_/doc/html
For example on a Linux system, copy the file `linuxdocs.sh` into the current directory and run it.

or

Option 2. You have already set up boost-root. The repo has already been placed in boost-root/libs/_name-of-this-repo_, and that's where you run the build. In that case, the docs are output in the current directory, such as _name-of-this-repo_/doc/html. The existing boost-root is used.

Either of the above choices are possible. The build scripts detect if they are being run from a boost-root or not.

In order to build the documentation, refer to the appropriate sections below:

## Linux

Run the linuxdocs.sh script which can be found in the doc/tools directory:
```
tools/linuxdocs.sh
./linuxdocs.sh
```


## Mac OSX

Run the osxdocs.sh script which can be found in the doc/tools directory:
```
tools/osxdocs.sh
```

## Windows

Run the powershell script windowsdocs.ps1 which can be found in the doc/tools directory:
```
.\tools\windowsdocs.ps1
```
The QuickBook or AsciiDoc files are compiled into html format.

## Help Card

To edit the Help Card in `HelpCard.org`, use LibreOffice Draw and install the
following fonts:

- [Cairo](https://fonts.google.com/specimen/Cairo)
- [M+ 1M](https://www.fontsquirrel.com/fonts/m-1m)
- [M+ 1M](https://www.fontsquirrel.com/fonts/m-1m)
84 changes: 0 additions & 84 deletions doc/tools/linuxdocs.sh

This file was deleted.

85 changes: 0 additions & 85 deletions doc/tools/osxdocs.sh

This file was deleted.

174 changes: 0 additions & 174 deletions doc/tools/windowsdocs.ps1

This file was deleted.

0 comments on commit 02c6984

Please sign in to comment.