Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
Frama-C Website
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
pub
Frama-C Website
Merge requests
!71
Update README
Code
Review changes
Check out branch
Download
Patches
Plain diff
Merged
Update README
feature/basile/readme
into
master
Overview
0
Commits
1
Pipelines
1
Changes
1
Merged
Basile Desloges
requested to merge
feature/basile/readme
into
master
4 years ago
Overview
0
Commits
1
Pipelines
1
Changes
1
Expand
0
0
Merge request reports
Viewing commit
a9280f99
Show latest version
1 file
+
56
−
6
Inline
Compare changes
Side-by-side
Inline
Show whitespace changes
Show one file at a time
a9280f99
Update README
· a9280f99
Basile Desloges
authored
4 years ago
README.md
+
56
−
6
Options
@@ -5,15 +5,23 @@ have to install anything, since everything is generated by the continuous integr
# For contributing #
If you want to edit the website before the release, for updating informations,
for releasing your plugin, I strongly encourage you to do so. As usual you can use a
branch
`feature/...`
and a merge-request to
`master`
.
## Git LFS ##
Get Git LFS from the
`git-lfs`
package or directly from:
```
curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
sudo aptitude install git-lfs
```
Get the repository normal
y
:
Get the repository normal
ly and initialize Git LFS
:
```
git clone git@git.frama-c.com:frama-c/frama-c.frama-c.com
cd frama-c.frama-c.com
git lfs install
```
The bigfiles of the website (
*.pdf, *
.tar.gz) are not directly in the git
@@ -31,10 +39,52 @@ Or all pdf:
git lfs pull -X "" -I "*.pdf"
```
If you want to edit the website before the release, for updating informations,
for releasing your plugin, I strongly encourage you to do so. As usual you can use a
branch
`feature/...`
and a merge-request to
`master`
.
If you want to add a bigfile you have nothing to do.
`git push`
will
send the needed files.
## Generate the changelog page ##
The changelog page isn't present in the repository but is generated each time
from the original changelogs. To generate it locally, you can execute the
following commands:
```
cd generator
chmod +x ./generate
curl https://git.frama-c.com/api/v4/projects/780/repository/files/Changelog/raw?ref=master > ../assets/Changelog
curl https://git.frama-c.com/api/v4/projects/780/repository/files/src%2Fplugins%2Fe-acsl%2Fdoc%2FChangelog/raw?ref=master >> ../assets/Changelog
curl https://git.frama-c.com/api/v4/projects/780/repository/files/src%2Fplugins%2Fwp%2FChangelog/raw?ref=master >> ../assets/Changelog
./generate ../assets/Changelog -o ../html/changelog.html
```
## Installing a development environment ##
The website is using Ruby dependencies to generate a static site. The
dependencies can be installed through bundler.
First check that Ruby and Ruby-gems are installed, if that's not the case check
your distribution documentation to install these two packages:
```
ruby -v
gem -v
```
Install Bundler:
```
gem install bundler -v '2.0.2'
```
Use Bundler to install the required dependencies, launch this command from the project root directory:
```
bundle install -j $(nproc) --path vendor
```
You can then either build the static site:
```
bundle exec jekyll build -d test --future
```
Or serve it locally to see your modifications in realtime by accessing
<http://127.0.0.1:4000>
:
```
bundle exec jekyll serve
```
\ No newline at end of file
Loading