Git Product home page Git Product logo

Comments (2)

OliverJAsh avatar OliverJAsh commented on September 23, 2024

Have you seen the code for the example?

Scribe comes as an AMD module that is available through the Bower registry. requireing it will give you the Scribe constructor, which you use as per the example: https://github.com/guardian/scribe/#usage-example.

If you are not familiar with concepts such as AMD, module systems such as this (and mainly this) are very much the bread and butter for most front-end libraries (the well-behaved ones).

If you can tell me where you got up to and where you got stuck, I might be able to provide more specific help, and off the back of that, improve the docs.

I am sorry that you are experiencing difficulty with this.

from scribe.

MichelBartz avatar MichelBartz commented on September 23, 2024

Thanks for the reply, sadly had to go with TinyMCE since the project I wanted to use Scribe in was due last week.

However I'm still personally interested in Scribe, so a couple things that might be helpful:

  • bower install scribe does not install a working copy of Scribe. That's where it first surprised me. At the very least put a clear list of dependencies and how to get them.
  • Don't assume everyone knows about the trendy package manager you are using. It's a fair assumption that most developer will not know about it. I knew Bower, AMD on the other hand is a CPU brand as far as I'm concerned, and may be they should rename it because it is confusing as fuck, but I digress.
  • Digging in the code, which is something I did, is not a recommended way of figuring out how things work. Specially if you expect a novice to figure things out, or simply somebody like me who is not front-end familiar.

Basically all I'm saying is clarify the installation section so that it includes all necessary steps and dependencies to get a fresh copy of Scribe running, not from the example. From what I understand, right now it would need a simple list of dependencies and a bower.json code example (within the instruction) to get the minimum running. Something simple like Step 1 ..... _Step 2_ ....

Btw I got it to work, and my problem was because when I started digging in to compare my code with yours I screwed up my bower.json leaving out AMD dependency (hence why it refused to work). My fault, but would have been avoided with clear installation instructions that leave the user with a working copy.

from scribe.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.