Update Readme, CI and docs #75
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ttice walker examples
Docs/improve docs
…ranch from GitHub
docs: add instructions for installing FreeBird package and specific b…
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes various updates and improvements across multiple files, primarily focusing on CI configuration, documentation, and workflows. The most important changes include updates to the CI configuration for better compatibility, enhancements to documentation, and modifications to workflow files for improved functionality.
CI Configuration Updates:
.github/workflows/CI.yml: Updated matrix keys fromversionandarchtojulia-versionandjulia-arch, added new versions and architectures, and upgraded actions to newer versions..github/workflows/CI.yml: Added a conditional check to upload coverage only for Julia version '1'.Workflow Enhancements:
.github/workflows/CompatHelper.yml: ModifiedCompatHelper.main()to run on thedevbranch..github/workflows/TagBot.yml: Added new conditions and permissions to the TagBot workflow. [1] [2]Documentation Improvements:
README.md: Updated coverage badge to reflect the main branch and added a code style badge.README.mdanddocs/src/index.md: Added instructions for installing theFreeBirdpackage and specific branches from GitHub. [1] [2]docs/src/quick_start.md: Expanded the quick start guide with detailed steps for using atomistic and lattice walkers, defining Hamiltonians, and running simulations. [1] [2]scripts/quick_start.jl: Synchronized script with the updated quick start guide in the documentation. [1] [2] [3]Minor Fixes:
docs/make.jl: Corrected file names and commented out thedevbranchparameter indeploydocs. [1] [2]