Skip to content
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

Improve ReadMe #22

Merged
merged 10 commits into from
Oct 16, 2023
Merged

Improve ReadMe #22

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4a90f5e
Improve ReadMe
Tortar Oct 13, 2023
5c708e0
Update README.md
Tortar Oct 13, 2023
c751259
Update test.yml
Tortar Oct 13, 2023
d59f78c
Update test.yml
Tortar Oct 13, 2023
a505a82
Update test.yml
Tortar Oct 13, 2023
b92059d
Update test.yml
Tortar Oct 13, 2023
d258b59
Update README.md
Tortar Oct 13, 2023
3de0e2b
Update README.md
Tortar Oct 14, 2023
284db76
Merge branch 'master' into patch-5
Tortar Oct 16, 2023
de2b659
fix ci button
BeastyBlacksmith Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# ProtoStructs
# ProtoStructs.jl

[![Build Status](https://travis-ci.com/beastyblacksmith/ProtoStructs.jl.svg?branch=master)](https://travis-ci.com/beastyblacksmith/ProtoStructs.jl)
[![Codecov](https://codecov.io/gh/beastyblacksmith/ProtoStructs.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/beastyblacksmith/ProtoStructs.jl)
[![Run tests](https://github.com/BeastyBlacksmith/ProtoStructs.jl/actions/workflows/test.yml/badge.svg)](https://github.com/BeastyBlacksmith/ProtoStructs.jl/actions/workflows/test.yml) ![Codecov](https://codecov.io/gh/beastyblacksmith/ProtoStructs.jl/branch/master/graph/badge.svg)

You are developing a new datastructure and are tired of restarting everytime you change your mind?
`ProtoStructs` lets you have `structs` which behave like they would have been redifined.

Here is how you do
Here is how it works:

Like:
```julia
using ProtoStructs

@proto struct DevType
@proto @kwdef struct DevType
a::Int = 1
b::Float64 = 2.0
c
Expand All @@ -22,8 +20,10 @@ b = DevType(c=:boo)
c = DevType(2, 4.0, nothing)
```

Redefine at will, but please remove the `@proto` macro after developing.
Redefine at will, but remove the `@proto` macro after developing to ensure correctness and improve performance of your code.



---

There is also [Redef](https://github.com/FedericoStra/RedefStructs.jl)
For julia `VERSION < v"1.8"` there is also [Redef](https://github.com/FedericoStra/RedefStructs.jl).
Loading