Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
flatsiedatsie authored Jan 15, 2024
1 parent f7a846f commit d81810f
Showing 1 changed file with 17 additions and 23 deletions.
40 changes: 17 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,32 @@
# homeRoughEditor Version 0.95
# Floorplanner

Help me to make this project an essential and free resource for all, so that any developer / integrator can propose to create **_plans for house_, _apartment_**, etc. online. **Full Javascript**, No external library with Jquery (only for Bootstrap), Boostrap 5 and FontAwesome. For cons, forgive me for my English, it is very rusty !!!

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Installing
This project is based on HomeRoughEditor Version 0.95

You just have to copy the files into a directory and open the index.html file in your browser. Version 0.93 of homeRoughtEditor is operational from **Mozilla 39!**

### See example
[![homeRoughEditor](https://raw.githubusercontent.com/ekymoz/homeRoughEditor/master/test.jpg)](https://ekymoz.github.io/homeRoughEditor/)]
## Getting Started

## Running the tests
Download the project as a zip file and open index.html. Or upload it to your webserver.

Personally I only test all this with the mozilla debug console
Data is stored in the browser's local storage, so if you clear your cookies, then your creations will also be deleted.

## TODO
- Make TouchScreen functions for tablet (or smartphone, but too tiny screen i think...)
- Make interoperability for browsers (actually good for Moz.)
- Refine the CSS and buttons behavior
- Refine the Historical system (use LocalStorage)
- Complete the translation (i'm French)
- Make your own system/functions to export plan to any database
## Features
- Easy to use, with touch support.
- 100% privacy friendly. It runs 100% in your own browser, and has no third party dependencies.
- Download your floorplan as an SVG file.
- Upload an existing home blueprint to use as a drawing template.
- Work on multiple floorplans at once.
- Wall lengths and (total) floor area are automatically calculated.
- Add emojis and other shapes. These can be scaled and rotated.
- Switch between edit mode and a simpler view mode.

## Built With

* [Atom.io](https://atom.io/) - My code editor. Simple and free.
* [Bootstrap](getbootstrap.com/docs/3.3/) - Bootstrap, a sleek, intuitive, and powerful mobile first front-end framework for faster and easier web development.
### Screenshot
[![homeRoughEditor](https://raw.githubusercontent.com/candlesmarthome/homeRoughEditor/master/screenshot.png)](https://candlesmarthome.github.io/homeRoughEditor/)]

## License

This project is licensed under the MIT License - see the [LICENSE.md](https://en.wikipedia.org/wiki/MIT_License) on Web file for details
This project is licensed under the MIT License - see the [LICENSE.md](https://en.wikipedia.org/wiki/MIT_License) for details.



0 comments on commit d81810f

Please sign in to comment.