search

ultimate-research / ssbh_lib

Reading and writing SSBH file formats in Rust
MIT License
8 stars 3 forks source link

Add getting started guide #71

Closed ScanMountGoat closed 3 years ago

ScanMountGoat commented 3 years ago

The documentation for ssbh_lib should list the two lines that people will likely need to know. Ssbh::from_file and Ssbh::write_to_file and potentially Mesh::from_file. The paragraphs about the objectives are redundant and can be merged into the examples and macro explanation. This can probably just go on the readme.

ScanMountGoat commented 3 years ago

Most users will just need to

  1. Import ssbh_lib
  2. Call from_file
  3. Check the relevant format documentation
  4. Call write_to_file