Skip to content

Commit

Permalink
up docs : README (explain rename)
Browse files Browse the repository at this point in the history
also fixes version in docs/antora.yml and docs/package.json

code skip
  • Loading branch information
prudhomm committed Apr 23, 2023
1 parent 2ee2d1d commit 7a46af1
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
11 changes: 9 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,16 @@ The documentation for feelpp-project is available at link:https://feelpp.github.

== Renaming the project

By default the project is named the project, you need to the following script and ansewer the questions:
By default the project is named `feelpp-project` if you cloned the repository `feelpp/feelpp-project`.
However if you used the previous repository as a template, then the project is renamed using the name of the repository using the script `rename.sh` at the initialization of the repository.
If the name does not suit you, you can change it again using the script `rename.sh` and providing the new name as argument.

$ bash rename.sh
WARNING: the script `rename.sh` will rename the project however some url might be set properly if you rename the project yourself. You need to check the following files: `docs/site.yml` and `docs/package.json` and fix the urls after the rename process is done.

== Updating the {project} version

The version of the project is defined in the files `CMakeLists.txt`, `docs/antora.yml` and `docs/package.json`.
You need to update with the same version in all files.

== Release process

Expand Down
2 changes: 1 addition & 1 deletion docs/antora.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: feelpp_project
title: Feel++ Project
version: ~
version: 2.0.0
start_page: ROOT:index.adoc
nav:
- modules/ROOT/nav.adoc
6 changes: 3 additions & 3 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"private": true,
"name": "feelpp-project",
"description": "The Feelpp documentation",
"version": "1.0.4",
"description": "The Feel++ Project documentation",
"version": "2.0.0",
"license": "AGPL-3.0",
"author": "The Feelpp Team",
"author": "The Feel++ Project Team",
"homepage": "https://github.com/feelpp/feelpp-project#readme",
"repository": {
"type": "git",
Expand Down

0 comments on commit 7a46af1

Please sign in to comment.