Skip to content

Commit

Permalink
Improve the readability of README (#851)
Browse files Browse the repository at this point in the history
### Before submitting

Please complete the following checklist when submitting a PR:

- [ ] All new features must include a unit test.
If you've fixed a bug or added code that should be tested, add a test to
the
      [`tests`](../tests) directory!

- [ ] All new functions and code must be clearly commented and
documented.
If you do make documentation changes, make sure that the docs build and
      render correctly by running `make docs`.

- [ ] Ensure that the test suite passes, by running `make test`.

- [ ] Add a new entry to the `.github/CHANGELOG.md` file, summarizing
the
      change, and including a link back to the PR.

- [ ] Ensure that code is properly formatted by running `make format`. 

When all the above are checked, delete everything above the dashed
line and fill in the pull request template.


------------------------------------------------------------------------------------------------------------

**Context:**
Update README file on base on my early experience with the code

**Description of the Change:**
Improve readability of the code, changing long peaces of text with
lists. Added subtitles to make more split section. Remove CMake compile
instructions because are confusing and it can made it by `pip`. Try to
make more clear the installation instructions for Lightning Kokkos.

**Benefits:**
Easier and faster way to read the README. 

**Possible Drawbacks:**

**Related GitHub Issues:**

[sc-71287]

---------

Co-authored-by: ringo-but-quantum <[email protected]>
Co-authored-by: Ali Asadi <[email protected]>
Co-authored-by: Amintor Dusko <[email protected]>
Co-authored-by: Isaac De Vlugt <[email protected]>
  • Loading branch information
5 people authored Aug 16, 2024
1 parent ec9e340 commit c591f46
Show file tree
Hide file tree
Showing 5 changed files with 149 additions and 117 deletions.
5 changes: 4 additions & 1 deletion .github/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,11 @@

### Documentation

* The installation instructions for all lightning plugins have been improved.
[(#851)](https://github.com/PennyLaneAI/pennylane-lightning/pull/851)

* Updated the README and added citation format for Lightning arxiv preprint.
[#818](https://github.com/PennyLaneAI/pennylane-lightning/pull/818)
[(#818)](https://github.com/PennyLaneAI/pennylane-lightning/pull/818)

### Bug fixes

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ clean:
.PHONY: python
python:
PL_BACKEND=$(PL_BACKEND) python scripts/configure_pyproject_toml.py
pip install -e . -vv
pip install -e . --config-settings editable_mode=compat -vv

.PHONY: wheel
wheel:
Expand Down
Loading

0 comments on commit c591f46

Please sign in to comment.