Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
andrews05 committed Sep 1, 2024
1 parent 6cfb53b commit b59cebd
Showing 1 changed file with 11 additions and 24 deletions.
35 changes: 11 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@

ResForge is a resource editor for macOS, capable of editing classic resource fork files and related formats. Based on [ResKnife](https://github.com/nickshanks/ResKnife) by Nicholas Shanks and Uli Kusterer, this derivative of the project has been rewritten for modern macOS systems.

### Features

## Installation

Download the latest version of ResForge from the [Releases](https://github.com/andrews05/ResForge/releases) page.

ResForge is compatible with macOS 10.15 or later and runs natively on both 64-bit Intel and Apple Silicon.


## Features

* Hexadecimal editor, powered by [HexFiend](https://github.com/HexFiend/HexFiend).
* Template editor, supporting a wide array of [field types](https://github.com/andrews05/ResForge/tree/master/ResForge/Template%20Editor#template-editor).
Expand All @@ -15,7 +23,7 @@ ResForge is a resource editor for macOS, capable of editing classic resource for
* Sound editor, supporting sampled 'snd ' resources.
* Dialog editor, supporting 'DITL' resources (by Uli Kusterer)
* Menu editor, supporting 'MENU', 'CMNU' & 'cmnu' resources (by Uli Kusterer)
* Tools for EV Nova, including a sprite (rlëD) editor, a ship animation (shän) editor and a galaxy viewer.
* Tools for EV Nova, including a sprite (rlëD) editor, a ship animation (shän) editor and a galaxy editor.

### Supported File Formats

Expand All @@ -26,17 +34,7 @@ ResForge is a resource editor for macOS, capable of editing classic resource for
* AppleSingle/AppleDouble encoded resource fork.


## Getting Started

### System Requirements

ResForge is compatible with macOS 10.15 or later and runs natively on both 64-bit Intel and Apple Silicon.

### Installation

Download the latest version of ResForge from the [Releases](https://github.com/andrews05/ResForge/releases) page.

### Building
## Building

To build ResForge yourself you will need to have Xcode 15 or later installed.

Expand All @@ -55,17 +53,6 @@ Make sure to use the `--recurse-submodules` option when cloning the repository,
* [resource_dasm](https://github.com/fuzziqersoftware/resource_dasm) - CLI tools for disassembling resource files.


## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request


## License

Distributed under the MIT License. See `LICENSE` for more information.

0 comments on commit b59cebd

Please sign in to comment.