Skip to content

Commit

Permalink
docs: update repository links and improve README content
Browse files Browse the repository at this point in the history
  • Loading branch information
Beforerr committed Dec 6, 2024
1 parent c46d59c commit e8cfadc
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 12 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# ChargedParticles.jl

[![Build Status](https://github.com/Beforerr/ChargedParticles.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Beforerr/ChargedParticles.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://beforerr.github.io/ChargedParticles.jl/dev/)
[![Build Status](https://github.com/JuliaPlasma/ChargedParticles.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaPlasma/ChargedParticles.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPlasma.github.io/ChargedParticles.jl/dev/)

A Julia package for working with charged particles in plasma physics, inspired by [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy)'s particles subpackage .
A Julia package for representing charged particles inspired by [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy)'s particles subpackage.

## Features

Expand All @@ -19,11 +19,6 @@ using Pkg
Pkg.add("ChargedParticles")
```

## Dependencies

- Unitful.jl: For handling physical units
- [Mendeleev.jl](https://github.com/Eben60/Mendeleev.jl): For periodic table data

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ makedocs(
)

deploydocs(
repo="github.com/Beforerr/ChargedParticles.jl",
repo="github.com/JuliaPlasma/ChargedParticles.jl",
)
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ChargedParticles.jl

[![Build Status](https://github.com/Beforerr/ChargedParticles.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/Beforerr/ChargedParticles.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://beforerr.github.io/ChargedParticles.jl/dev/)
[![Build Status](https://github.com/JuliaPlasma/ChargedParticles.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/JuliaPlasma/ChargedParticles.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Documentation](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaPlasma.github.io/ChargedParticles.jl/dev/)


A Julia package for representing charged particles inspired by [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy)'s particles subpackage.
Expand Down Expand Up @@ -51,7 +51,7 @@ println("Deuteron mass: ", mass(d))

- [PlasmaPy](https://github.com/PlasmaPy/PlasmaPy): A Python package for plasma physics.
- [Mendeleev.jl](https://github.com/Eben60/Mendeleev.jl): A Julia package for accessing periodic table data.
- [Corpuscles.jl](https://github.com/Beforerr/Corpuscles.jl): A Julia package for for particle physics.
- [Corpuscles.jl](https://github.com/JuliaPhysics/Corpuscles.jl): A Julia package for for particle physics.

## Manual Outline

Expand Down

0 comments on commit e8cfadc

Please sign in to comment.