Skip to content

Commit 5c5ca94

Browse files
jacobwilliamsjacobwilliams
committed
made some of the aux files dot files.
moved contributing file into a .github directory. Fixes #211
1 parent 28dc281 commit 5c5ca94

13 files changed

+27
-27
lines changed

‎preprocessor-def.md ‎.PREPROCESSOR

File renamed without changes.

‎__VERSION__ ‎.VERSION

File renamed without changes.

‎CONTRIBUTING.md ‎.github/CONTRIBUTING.md

File renamed without changes.

‎.travis.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ before_script:
8080
fi
8181
- |
8282
if [ "$TRAVIS_TAG" ]; then
83-
if [[ "v$TRAVIS_TAG" != "v$(cat __VERSION__)" ]]; then
84-
echo "ERROR: You are trying to tag a new release but have a version missmatch in \`__VERSION__\`"
83+
if [[ "v$TRAVIS_TAG" != "v$(cat .VERSION)" ]]; then
84+
echo "ERROR: You are trying to tag a new release but have a version missmatch in \`.VERSION\`"
8585
false # throw an error
8686
fi
8787
fi

‎CMakeLists.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ project ( jsonfortran NONE )
3434
# Get version (semantic versioning)
3535
# C.F. semver.org
3636
#----------------------------------
37-
file ( STRINGS "${CMAKE_SOURCE_DIR}/__VERSION__" VERSION )
37+
file ( STRINGS "${CMAKE_SOURCE_DIR}/.VERSION" VERSION )
3838
string( REPLACE "." ";" VERSION_LIST ${VERSION} )
3939
list(GET VERSION_LIST 0 VERSION_MAJOR)
4040
list(GET VERSION_LIST 1 VERSION_MINOR)
@@ -169,7 +169,7 @@ if ( NOT SKIP_DOC_GEN )
169169
else ()
170170
set ( FPP "gfortran -E\n" ) # default to gfortran -E for gfortran and unsupported compilers
171171
endif ()
172-
file ( WRITE "${CMAKE_BINARY_DIR}/preprocessor-def.md" "${FPP}" )
172+
file ( WRITE "${CMAKE_BINARY_DIR}/.PREPROCESSOR" "${FPP}" )
173173
# Dynamically generate the FORD outputs list
174174
message ( STATUS "Dynamically computing FORD output information..." )
175175
if ( NOT (DEFINED FORD_OUTPUTS_CACHED) )
@@ -192,7 +192,7 @@ if ( NOT SKIP_DOC_GEN )
192192
message ( STATUS "Done dynamically computing FORD outputs." )
193193

194194
foreach ( DOC_SRC_FILE ${JF_LIB_SRCS} ${JF_TEST_SRCS} ${CMAKE_SOURCE_DIR}/README.md
195-
${CMAKE_SOURCE_DIR}/CHANGELOG.md ${CMAKE_SOURCE_DIR}/CONTRIBUTING.md
195+
${CMAKE_SOURCE_DIR}/CHANGELOG.md ${CMAKE_SOURCE_DIR}/.github/CONTRIBUTING.md
196196
${CMAKE_SOURCE_DIR}/LICENSE ${CMAKE_SOURCE_DIR}/json-fortran.md ${PAGES_FILES} )
197197
list ( APPEND FORD_DEPENDS "${DOC_SRC_FILE}" )
198198
endforeach ()

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -145,9 +145,9 @@ Some examples can also be found on the [wiki](https://github.com/jacobwilliams/j
145145
Contributing
146146
------------
147147

148-
[![Ready in backlog](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Ready&title=Ready)](https://github.com/jacobwilliams/json-fortran/blob/master/CONTRIBUTING.md)
148+
[![Ready in backlog](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Ready&title=Ready)](https://github.com/jacobwilliams/json-fortran/blob/master/.github/CONTRIBUTING.md)
149149

150-
Want to help? Take a quick look at our [contributing guidelines](https://github.com/jacobwilliams/json-fortran/blob/master/CONTRIBUTING.md) then claim something in [the "ready" column on our Waffle.io](https://waffle.io/jacobwilliams/json-fortran) and [Fork. Commit. Pull request.](https://help.github.com/articles/fork-a-repo/)
150+
Want to help? Take a quick look at our [contributing guidelines](https://github.com/jacobwilliams/json-fortran/blob/master/.github/CONTRIBUTING.md) then claim something in [the "ready" column on our Waffle.io](https://waffle.io/jacobwilliams/json-fortran) and [Fork. Commit. Pull request.](https://help.github.com/articles/fork-a-repo/)
151151

152152
[top](#json-fortran)
153153

‎build.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ if [[ $JF_SKIP_DOCS != [yY]* ]]; then
347347
if hash ford 2>/dev/null; then
348348
echo "Building documentation..."
349349
[[ $TRY_UNICODE = [yY]* ]] && MACRO_FLAG=("-m" "USE_UCS4")
350-
echo "$FPP" > preprocessor-def.md # Override via include in project file, until FORD gets CLI for this
350+
echo "$FPP" > .PREPROCESSOR # Override via include in project file, until FORD gets CLI for this
351351
ford --debug "${MACRO_FLAG[@]}" -p "$PAGESDIR" "$FORDMD"
352352
else
353353
echo "FORD not found! Install using: sudo pip install ford"

‎json-fortran.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
project: JSON-Fortran
3-
preprocessor: {!preprocessor-def.md!}
3+
preprocessor: {!.PREPROCESSOR!}
44
favicon: ./media/json-fortran-32x32.png
55
project_dir: ./src
66
output_dir: ./doc
@@ -51,11 +51,11 @@ file for more details.
5151
Official Releases
5252
-----------------
5353

54-
The **current stable release** is **{!__VERSION__!}** and can be [downloaded
54+
The **current stable release** is **{!.VERSION!}** and can be [downloaded
5555
on GitHub](https://github.com/jacobwilliams/json-fortran/releases/latest)
5656
or installed with [Homebrew](http://brew.sh) on Mac OSX. The
57-
documentation for the current version, **{!__VERSION__!}**, can be
58-
found [here](http://jacobwilliams.github.io/json-fortran/{!__VERSION__!}/index.html)[^1], and a
57+
documentation for the current version, **{!.VERSION!}**, can be
58+
found [here](http://jacobwilliams.github.io/json-fortran/{!.VERSION!}/index.html)[^1], and a
5959
list of changes from the previous version are
6060
[here](http://jacobwilliams.github.io/json-fortran/page/releases/index.html#change-log).
6161

@@ -70,8 +70,8 @@ Miscellaneous
7070

7171
*[API]: Application Programming Interface: a set of routines, protocols, and tools for building software applications
7272
*[JSON]: JavaScript Object Notation: A human friendly syntax for storing and exchanging data
73-
*[current stable release]: {!__VERSION__!}
74-
*[latest stable release]: {!__VERSION__!}
73+
*[current stable release]: {!.VERSION!}
74+
*[latest stable release]: {!.VERSION!}
7575

7676
[^1]:
7777
Documentation for a particular release does not contain links

‎pages/development-resources/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
title: Contributing Guidelines
22

3-
{!CONTRIBUTING.md!}
3+
{!.github/CONTRIBUTING.md!}

‎pages/development-resources/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,4 +40,4 @@ deploying documentation and managing test coverage information.
4040

4141
[This](|url|/page/development-resources/release-checklist.html) is a
4242
checklist of tasks to be performed when tagging a new release of
43-
JSON-Fortran. The current stable version is **{!__VERSION__!}**.
43+
JSON-Fortran. The current stable version is **{!.VERSION!}**.

‎pages/development-resources/release-checklist.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ remain accurate.
1212
[Unreleased](|url|/page/releases/index.html#unreleased) are up
1313
to date and accurate.
1414
1. Look at the latest [changes committed to GitHub since the
15-
last release](https://github.com/jacobwilliams/json-fortran/compare/{!__VERSION__!}...HEAD),
16-
{!__VERSION__!}. This will only be accurate if you have
17-
not yet updated `__VERSION__`. If you *have* updated
18-
`__VERSION__` then edit the URL manually to view the
15+
last release](https://github.com/jacobwilliams/json-fortran/compare/{!.VERSION!}...HEAD),
16+
{!.VERSION!}. This will only be accurate if you have
17+
not yet updated `.VERSION`. If you *have* updated
18+
`.VERSION` then edit the URL manually to view the
1919
changes.
2020
1. Run the
2121
[`github_changelog_generator`](https://github.com/skywinder/github-changelog-generator)
@@ -51,9 +51,9 @@ remain accurate.
5151
string
5252
1. Add `pages/releases/index.md` to the git index: `git add pages/releases/index.md`
5353
1. Update the version string in remaining files requiring manual edits:
54-
1. Edit the `__VERSION__` file
54+
1. Edit the `.VERSION` file
5555
1. Edit the CMake example on line 123 of `README.md`
56-
1. Add both files to the git index: `git add __VERSION__
56+
1. Add both files to the git index: `git add .VERSION
5757
README.md`
5858
1. Commit the changes to the master branch: `git commit`
5959
1. Create the tag: `git tag <new version>`

‎pages/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Other Docs
33
# Current Stable Release
44

55
The latest stable release is
6-
[**{!__VERSION__!}**](
7-
http://jacobwilliams.github.io/json-fortran/{!__VERSION__!}/index.html).[^1]
6+
[**{!.VERSION!}**](
7+
http://jacobwilliams.github.io/json-fortran/{!.VERSION!}/index.html).[^1]
88

99
# Past Releases
1010

‎pages/releases/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ of the `master` branch, please head back to the
1212
## Latest Stable Release
1313

1414
**Documentation:**
15-
[{!__VERSION__!}](
16-
http://jacobwilliams.github.io/json-fortran/{!__VERSION__!}/index.html)
15+
[{!.VERSION!}](
16+
http://jacobwilliams.github.io/json-fortran/{!.VERSION!}/index.html)
1717

1818
**Download:**
1919
<https://github.com/jacobwilliams/json-fortran/releases/latest>
@@ -65,7 +65,7 @@ the [main project page](|url|/index.html) for convenient navigation.
6565
# Development Version
6666

6767
Documentation for the latest development version may be found at
68-
<https://jacobwilliams.github.io/json-fortran/{!__VERSION__!}/index.html>
68+
<https://jacobwilliams.github.io/json-fortran/{!.VERSION!}/index.html>
6969
or generated locally using the
7070
[build.sh](|url|/page/development-resources/build.sh.html) build
7171
script.

0 commit comments

Comments
 (0)