Skip to content

Commit

Permalink
Make documentation appear as the README.
Browse files Browse the repository at this point in the history
doc/ChangeLog:

	* .gitignore: Change name of files ignored.
	* Makefile: Remove publish target.
	* README.adoc: Symbolic link removed and replaced by design.adoc,
	to which the CC license text has been added.
	* design.adoc: Renamed as README.adoc.
	* publish.sh: Deleted.
  • Loading branch information
jeremybennett committed Jun 12, 2018
1 parent 564dfb1 commit 1dc4559
Show file tree
Hide file tree
Showing 7 changed files with 570 additions and 496 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The files [`COPYING.BSD`](./COPYING.BSD) and [`COPYING.CC`](./COPYING.CC) in the

## Running the compliance tests

The only setup required is to define where the toolchain is found, and where the Target Device is found
The only setup required is to define where the toolchain is found, and where the target device is found

In the Makefile there are 2 entries to be defined for `GCC_BIN` & `OVP_BIN`

Expand Down
4 changes: 2 additions & 2 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ignore editor backups
*~
# Generated files
design.pdf
README.pdf
# Geneated HTML
design.html
README.html
13 changes: 13 additions & 0 deletions doc/ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
2018-06-11 Jeremy Bennett <[email protected]>

This makes the document appear directly as the README of the doc
directory, so there is now no longer a need to publish to GitHub
pages.

* .gitignore: Change name of files ignored.
* Makefile: Remove publish target.
* README.adoc: Symbolic link removed and replaced by design.adoc,
to which the CC license text has been added.
* design.adoc: Renamed as README.adoc.
* publish.sh: Deleted.

2018-06-11 Jeremy Bennett <[email protected]>

* README.md: Previous version moved to README-old.md for the time
Expand Down
7 changes: 2 additions & 5 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

# SPDX-License-Identifier: BSD-3-Clause

ROOT = design
ROOT = README
SRC = $(ROOT).adoc
SRC_STRIPPED = $(ROOT)-stripped.adoc

Expand Down Expand Up @@ -78,8 +78,5 @@ spell: custom.dict $(SRC)
-c $(SRC_STRIPPED)
$(RM) $(SRC_STRIPPED)

publish: $(ROOT).html
./publish.sh

clean:
rm -f $(ROOT).pdf $(ROOT).html custom.dict
rm -f $(ROOT)-stripped.adoc $(ROOT).pdf $(ROOT).html custom.dict
1 change: 0 additions & 1 deletion doc/README.adoc

This file was deleted.

Loading

0 comments on commit 1dc4559

Please sign in to comment.