Skip to content

83 update readme #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
vincentchabannes merged 67 commits into from
Mar 5, 2025
Merged

83 update readme #251

vincentchabannes merged 67 commits into from
Mar 5, 2025

Conversation

@JavierCladellas
Copy link
Collaborator

@JavierCladellas JavierCladellas commented Feb 28, 2025 •
edited
Loading

Prepared the repository for release. The framework can now be installed with pip.

Done:

  • Added a better README
  • Improved documentation
  • Added option to pass custom ReFrame configuration files
  • Clean repo and CI, simplify docker image (not use feel++)
  • Changed executable names
  • Configure automatic PyPi release

@prudhomm Could you help me with writing the CD step to publish to PyPi on release ? pyproject.toml is ready.

@JavierCladellas
start new readme #83
ec83039
@JavierCladellas
Merge branch 'master' into 83-update-readme
b2eb46d
@JavierCladellas
Merge branch 'master' into 83-update-readme
d05b5fc
@JavierCladellas
add very simple system rfm config
837bfbe
@JavierCladellas
accept passing custom reframe config files
ddce252
@JavierCladellas
use pyproject dependencies
16b9790
@JavierCladellas
setuptools
f3c6c27
@JavierCladellas
up readme #83
372426d
@JavierCladellas
add links #83
9378ef8
@JavierCladellas
minor
0cbfd6a
@JavierCladellas
up getting started (duped)
6e1cc77
@JavierCladellas
rm duped text
bf8675b
@JavierCladellas
add doc index (duped)
4f797ca
@JavierCladellas
up system configuration in doc
08b8816
@JavierCladellas
fix test
79aecb4
@JavierCladellas
NOTE -> CAUTION
ac55c72
@JavierCladellas
Merge branch '83-update-readme' of https://github.com/feelpp/benchmar…
b5e47b5 
…king.toolboxes into 83-update-readme
@JavierCladellas
up machine configuration #83
992ffdb
@JavierCladellas
Merge branch 'master' into 83-update-readme
18a77cc
@JavierCladellas
add resources section
f927c9d
@JavierCladellas
fix append_app_options
39294b0
@JavierCladellas
add platforms section
16b05d2
@JavierCladellas
write scalability section
94bada1
@JavierCladellas
write additional files documentation
8b7ff61
@JavierCladellas
add sanity
e186eba
@JavierCladellas
add base
bb68fed
@JavierCladellas
add parameters
f2b9bbe
@JavierCladellas
init advanced config
7768cb2
@JavierCladellas
fix
ba22530
@JavierCladellas
Merge branch '238-do-not-hardcode-account-information' into 83-update…
2b93409 
…-readme
@JavierCladellas JavierCladellas marked this pull request as ready for review March 3, 2025 10:19
@github-project-automation github-project-automation bot moved this from Backlog to Todo in Feel++ Mar 5, 2025
@vincentchabannes vincentchabannes merged commit 8f60b5e into master Mar 5, 2025
12 of 14 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Feel++ Mar 5, 2025
@vincentchabannes vincentchabannes deleted the 83-update-readme branch March 5, 2025 10:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vincentchabannes vincentchabannes vincentchabannes approved these changes

@prudhomm prudhomm Awaiting requested review from prudhomm

Assignees

@JavierCladellas JavierCladellas

Labels

documentation Issues related to documentation enhancement A new feature or request

Projects

Feel++
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update README

3 participants

@JavierCladellas @vincentchabannes