Skip to content

Commit 9a8fae7

Browse files
committedDec 11, 2020
Update README with new documentation links
1 parent 49acbe5 commit 9a8fae7

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed
 

‎README.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ __[fpm](https://github.com/fortran-lang/fpm) package implementing a hash table w
77

88

99

10+
## fpm usage
11+
12+
To use *fhash* within your *fpm* project, add the following to your package manifest file (`fpm.toml`):
13+
14+
```toml
15+
[dependencies]
16+
fhash = { git = "https://github.com/LKedward/fhash.git" }
17+
```
18+
19+
1020
## Simple example: scalar intrinsics
1121

1222
The package provides a `fhash_tbl_t` type with `set` and `get` methods for storing and retrieving key-value pairs.
@@ -29,20 +39,14 @@ program fhash_demo1
2939
end program fhash_demo1
3040
```
3141

32-
- The `set` method will accept any scalar variable as a value including derived types
33-
34-
- The `get` method has generic support for retrieving scalar values of the following types: `integer(int32)`, `integer(int64)`, `real(real32)`, `real(real64)`, `character(*)`, `logical`
35-
36-
- `fhash_key` has generic support for generating keys from scalar or 1D arrays of integers (`integer(int32)`, `integer(int64)`) or from scalar `character(*)`
42+
See the [Quickstart Guide](https://lkedward.github.io/fhash/page/index.html) for an explanation of this example and the API methods used.
3743

3844

3945
## Advanced usage
4046

41-
- [Storing custom derived types as values](./app/derived_type_demo)
42-
- [Using custom derived types as keys](./app/custom_key_demo)
43-
- Storing and retrieving pointers (*coming soon*)
44-
47+
- [More table methods](https://lkedward.github.io/fhash/page/1-methods-demo/index.html)
48+
- [Storing custom derived types as values](https://lkedward.github.io/fhash/page/2-derived-type-demo/index.html)
49+
- [Using custom derived types as keys](https://lkedward.github.io/fhash/page/3-custom-key-demo/index.html)
4550

46-
## Full API Documentation
4751

48-
See <https://lkedward.github.io/fhash/>
52+
See <https://lkedward.github.io/fhash/> for the full API documentation.

0 commit comments

Comments
 (0)